home *** CD-ROM | disk | FTP | other *** search
- /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
- /* ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is mozilla.org code.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications Corporation.
- * Portions created by the Initial Developer are Copyright (C) 1998
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either of the GNU General Public License Version 2 or later (the "GPL"),
- * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
-
- #include "nsISupports.idl"
-
- /**
- * nsIErrorService: This is an interim service that allows nsresult codes to be mapped to
- * string bundles that can be used to look up error messages. String bundle keys can also
- * be mapped.
- *
- * This service will eventually get replaced by extending xpidl to allow errors to be defined.
- * (http://bugzilla.mozilla.org/show_bug.cgi?id=13423).
- */
- [scriptable, uuid(e72f94b2-5f85-11d4-9877-00c04fa0cf4a)]
- interface nsIErrorService : nsISupports
- {
- /**
- * Registers a string bundle URL for an error module. Error modules are obtained from
- * nsresult code with NS_ERROR_GET_MODULE.
- */
- void registerErrorStringBundle(in short errorModule, in string stringBundleURL);
-
- /**
- * Registers a string bundle URL for an error module.
- */
- void unregisterErrorStringBundle(in short errorModule);
-
- /**
- * Retrieves a string bundle URL for an error module.
- */
- string getErrorStringBundle(in short errorModule);
-
- /**
- * Registers a key in a string bundle for an nsresult error code. Only the code portion
- * of the nsresult is used (obtained with NS_ERROR_GET_CODE) in this registration. The
- * string bundle key is used to look up internationalized messages in the string bundle.
- */
- void registerErrorStringBundleKey(in nsresult error, in string stringBundleKey);
-
- /**
- * Unregisters a key in a string bundle for an nsresult error code.
- */
- void unregisterErrorStringBundleKey(in nsresult error);
-
- /**
- * Retrieves a key in a string bundle for an nsresult error code. If no key is registered
- * for the specified nsresult's code (obtained with NS_ERROR_GET_CODE), then the stringified
- * version of the nsresult code is returned.
- */
- string getErrorStringBundleKey(in nsresult error);
- };
-
- %{C++
-
- // The global nsIErrorService:
- #define NS_ERRORSERVICE_NAME "Error Service"
- #define NS_ERRORSERVICE_CONTRACTID "@mozilla.org/xpcom/error-service;1"
- #define NS_ERRORSERVICE_CID \
- { /* 744afd5e-5f8c-11d4-9877-00c04fa0cf4a */ \
- 0x744afd5e, \
- 0x5f8c, \
- 0x11d4, \
- {0x98, 0x77, 0x00, 0xc0, 0x4f, 0xa0, 0xcf, 0x4a} \
- }
-
- %}
-